================================READ THIS===============================
calb, Galtor and _Demo_ hold no warranties of any kind for this product.
You're using ePSXe at your own risk. The authors can't be held liable
or responsible for any damage which results from using the emulator,
it's plugin or anything described in this documentation in any way.
================================READ THIS===============================

Index
*****
0. Introduction.
1. What's New?
2. What do you need to run EPSXE?
3. Usage.
   3.1  Which files are necessary to run EPSXE?
   3.2. Controlling the emulator.
   3.3. GUI options
        3.3.1. File
        3.3.2. Run
        3.3.3. Config
        3.3.4. Options
        3.3.5. Cheat
        3.3.7. Help
   3.4. Configure the emulator
        3.4.1. Configuring the emulator
        3.4.2. Configuring the video options
        3.4.3. Configuring the CD-Rom
        3.4.4. Configuring the sound
        3.4.5. Configuring MDEC
   3.5. Command line options
   3.6. Emulator patches
   3.7. Memory card support
4. Implemented features
5. Compatibility in EPSXE
6. Where can I get help with the emulator?

Appendix
********
A. FAQ's
B. Thanks
C. Legal Stuff

****************************************************************************
0.  Introduction
****************************************************************************

ePSXe is a Sony Playstation emulator for your PC running under Windows.
It takes advantage of the popular PSEmu Pro plugin system.

****************************************************************************
1.  What's New?
****************************************************************************

ePSXe v1.0.0, released on 14.10.2000
- First release.

******************************************************************************
2.  What do you need to run EPSXE?
******************************************************************************

Minimum system requirements:
  P200 or compatible
  32 MB of RAM
  Fast graphic card (like the voodoo 2)
  Cdrom x16
  Win9x
  DirectX 7a

Recommended system configuration:
  P2 400 or greater
  64 Mb of RAM
  Very fast DirectX, Opengl or Glide graphic card
  fast CD-ROM
  Win9x
  DirectX 7a

*****************************************************************************
3. Usage
*****************************************************************************

3.1  Which files are necessary to run EPSXE?

* epsxe.exe
* a psx bios (scph1001.bin and scph7502.bin have been tested and proved to work)
* PSEmu Pro GPU plugin (graphics)
* PSEmu Pro SPU plugin (sound)
* PSEmu Pro CD-Rom plugin

3.2 Controlling the emulator

  ePSXe supports direct input and also features an option which allows you
  to configure the pads through the GUI. It is very simple and intuitive :
  Click config -> controller -> pad1/pad2 (the one you want to configure),
  and you will see a picture of a pad and some fields with the names of 
  the keys. Select the psx button what you want configure and then hit the 
  key you want to assign to it. (in case you want use a joystick, hit the 
  joystick button instead of a key).

  ePSXe includes 4 fast keys to change some param of the emu:

  - F1-Enable/Disable Xa sound.
  - F2-Enable/Disable Xa read.
  - F3-Enable/Disable SPU irq.
  - F4-Enable/Disable SIO irq.

Player 1 - default
------------------

    PC Keys              PSX Buttons
------------------------------------------
       S         |          Square
       D         |          Triangle
       Z         |            X
       X         |          Circle
       C         |          Select
       V         |          Start
       W         |            L1
       Q         |            L2
       E         |            R1
       R         |            R2
   Arrow keys    |    Directional buttons

Player 2 - default
------------------
Disabled by default.


3.3. GUI options.

On startup, you can see ePSXe's menus which include the following
options:

3.3.1. File.

 (*) Run CDROM : Runs a PSX CD-Rom

 (*) Run BIOS : Runs the PSX bios. (use this to edit the memory cards)

 (*) Run ISO : Runs a PSX iso file. Select an iso file and click ok to start.

 (*) Run PSX-EXE : Runs a PSX-EXE file (exe or .zip), or runs
                   a multifile .PLL, which has to be included with
                   the other files in a .zip

 (*) Exit : Quit the emulator.

3.3.2. Run.

 (*) Continue : Continues a previously stopped cdrom/iso/psx-exe/bios game

 (*) Reset : Reset emulation.

3.3.3. Config.

 (see 3.4. Configure the emulator)

3.3.4. Options.

  (*) SIO irq always enable : always enables irq SIO.

3.3.5. Cheat.

  (see 3.6. Emulator patches)

3.3.7. Help.

  (*) Visit EPSXE webpage : Open your browser with the epsxe webpage.

  (*) About : Credits.

3.4. Configuring the emulator.

Basically you need to configure the bios, your video card, CD-ROm drive and
your sound card in order to get the emulator fully working.

3.4.1. Configuring the bios.

In ePSXe, click config -> bios. In the new window, you can see a text box 
which shows the currently selected bios and a browse button. Click this button
and select the BIOS you want to use. During testing we found out that the 
scph1001.bin and scph7502.bin BIOS' are compatible, but the scph1000.bin won't
work. Please remember you may only be in possession of the copyrighted BIOS 
when you're legally entitled.

3.4.2. Configuring the video options.

In ePSXe, click config -> video. In the new window, you can see a dropdown menu
which shows the currently selected video plugin(*). Select your favourite video 
plugin and click on the configure button, and, finally click ok.

(*) EPSXE uses PSEmu Pro's video plugins, so in order to use ePSXe, you need to 
download them from their webpages first.

3.4.3. Configuring the CD-Rom

in ePSXe, select config -> cdrom. In the new window, you can see a dropdown menu
which shows the currently selected CD-Rom plugin(*). Select the plugin of your
choise and click on the "Configure" button afterwards. There's yet another dropdown
menu, in which you can select the drive letter of the CD-Rom you want to use. In case
you want to use your primary CD-Rom, just stay with the default entry. For using
another CD-Rom, just select the preferred drive and click on OK. We mainly tested
the emulator with cdrTsgMSCD.dll (Tanishige Ryus plugin), some beta testers randomly
had problems with with other plugins, so just try your favorite plugin first and when
it doesn't work, just use the one mentioned above (keep in mind that cdrTsgMSCD.dll 
needs the two files subTsgMSCD16.dll and subTsgMSCD32.dll in the emulators root 
directory). Win2k users should use the ASPI plugin, it worked fine during our tests.

ePSXe also includes an option called "cdrom timing accurate". It changes the CD-Rom
timing, what allows to partially play some games like Gran Tourismo and Point Blank 2.

(*) EPSXE uses PSEmu Pro's CD-Rom plugin system, so you need download the plugins from
    any webpage first.

3.4.4. Configuring the sound.

In ePSXe, select config -> sound. In the new window, you can see a dropdown menu
which shows the currently selected sound plugin(*). Select the sound plugin of
your choise and click on the "Configure" button afterwards. In the appearing
window, there're several check boxes where you can enable disable certain
sound options. The playstation uses 3 different kind of sounds : ADPCM, XA
and CDDA.

* Enable Sound  (Select this to enable ADPCM sound) - Used to enable ADPCM
sound, and it is necessary to get XA sound.

* Enable XA sound (Select this to enable XA sound during MDECs) - Used to
enable XA sound in general, when only the XA option is enabled you'll just
get sound during MDEC movies.

* Enable XA read (Select to enable in-game XA sound) - Used to enable 
XA sound during the game itself. (of course only when the game uses
XA sound). To use this, you need to activate the ADPCM and XA sound 
options first. (WARNING : STILL VERY BUGGY AND SLOW)

* Enable CDDA Sound (Select to enable CDROM sound) - Used to enable 
CDDA sound (mainly music).

* Enable SPU IRQ (required for some games) - Enables the SPU IRQ,
which is necessary to play some games.

(*) EPSXE can use PSEmu Pro's sound plugin system or an internal
    sound system. If you want to use psemu plugins you need download the
    plugins first.

3.4.5. Configuring MDEC.

In this window, there're two check buttons. With the first one, you can
enable/disable the MDECs completly, with the second one you can select a 
different mdec timing. This is only necessary for FF8 and FF9, so please
disable it for playing other games, or play them at your own risk.

3.5. Command line options.

epsxe [options] [psx-exe]

 (*) -lib              : Loads the libps.exe, which is necessary for running several
                         demos. You should have the file libps.exe in ePSXe's root
                         directory.

 (*) -nocd             : Disables the CD-Rom emulation. ( not recommended ! ;-) )

 (*) -nosound          : Disables ADPCM and XA sound output.

 (*) -xasound          : Enable XA sound decoding.

 (*) -xaread           : Enable continue XA read from cdrom. (necessary in music
                         during the game)

 (*) -noaudiocd        : Disables CDDA sound.

 (*) -forcespu         : Forces SPU IRQ always ON. This is necessary for some games.

 (*) -cdslow/-cdfast   : Selects the CD-Rom emulation mode, default is
                         cdslow, which is far more compatible than cdfast.

 (*) -cdtiming         : Enables accurate CD-Rom timing. This is, in general, less
                         compatible, but some games only work once this option is
                         enabled, like Resident Evil 2 and Point Blank 2.

 (*) -cdrom <letter>   : You can select which CD-Rom drive you want to use.

 (*) -forcepad         : Force pad IRQ always switched ON. This MIGHT fix some pad 
                         problems in certain games. (this isn't force feed back related)

 (*) -nomemcard        : Disables memory card emulation.

 (*) -nogui            : Runs the emulator without any GUI.

 (*) -nomdec           : Disables MDEC emulation. You need to disable MDECs when games
                         crash while playing videos.

 (*) -f                : Does fast boot cdrom.

 (*) -loadbin <file>   : Runs an iso image.

 (*) -loadcheat <file> : Loads a file for cheating.

 (*) -loadmemc0 <file>
     -loadmemc1 <file> : Loads a memorycard file in the selected slot.

     [psx-exe]         : PSX-EXE, normal, zipped or .PLL with all files 
			 included in a .zip


3.6. Emulator patches.

Some games, which normally wouldn't run in ePSXe, will start when using
cheat codes. Patches for several games are already included in the
emuator ! To select them, click on "Cheats" in ePSXe, load the game
patch you need and enjoy ;-)

This function shouldn't be used to cheat in games, we recommend you to
use [pec] (http://pec.emucheater.com) for in game cheating.


3.7. Memory cards support.

ePSXe also comes along with memory card support. The used cards are saved
in 2 files in your \memcards directory. The first one is named epsxe000.mcr 
and the second one epsxe001.mcr. Each file has a size of 128 KB (which is
PSX standard), and the format is simply a dump of real memory cards.

ePSXe doesn't come with a memory card editor, but you can use the option
Load -> Run BIOS to get to the real PSX memory card editor, from where
you can delete / move savegames. In case you're using Pete's OpenGL / D3D
plugins, don't forget to enable offscreen rendering to see this menu 
correctly.

******************************************************************************
4.  Implemented features
******************************************************************************

- The complete r3000 instruction set

- Imcomplete COP0 coprocessor emulation 

- Buggy GTE coprocessor emulation 

- Sio emulation 

- Memory card support

- ISO support

- PSEmu Pro video plugins support 

- PSEmu Pro sound plugins support 

- PSEmu Pro CD-Rom plugins support

- Buggy Mdec decoder ( The PSX comes with a jpeg decoder which is mainly used
  for MDEC movies. It is emulated in ePSXe thanks to help from the FPSE team,
  but it is actually still very buggy and will be re-written for future
  versions.)

- CDDA sound support

- Partial XA sound

- GUI

*******************************************************************************
5.  Compatibility in EPSXE
*******************************************************************************

Compatibility in ePSXe hasn't been tested that much yet, actually it has been
mainly tested with PAL games. Current compatibility percentage is around
30% - 45%.

Some games known to work are :

- Colin McRae Rally 1 and 2
- Crash Bandicoot 3
- Driver
- Fifa 99/2000.
- Final Fantasy 7 and 8
- Iss98, Isspro evolution
- Knockout Kings 99, 2000
- NBA Live 2000
- Need For Speed IV
- Ridge Racer
- Ridge Racer type 4
- Soulblade
- Spyro The Dragon
- Syphon Filter 1 and 2
- Tekken3
- Tigger Woods 99, 2000
- Tomb Raider 3
- Vagrant Story
- and many more ...

Once you start a game in EPSXE various things can occur:

   - The game works correctly.
       Solution: "Be happy !" :) Send us a screenshot when you're
       through the game.

   - The game works but you get graphics problems.
       Solution : ePSXe uses the PSEmu Pro plugins to draw the graphics to
       your screen, so you could try a different plugin.

   - The game works but you get 3d graphics or light problems.
       Solution:  EPSXE has a more or less complete GTE emulation, but
       several GTE opcodes are still very buggy :-(. Wait for the  next
       version. You can also try another plugin to make sure it's really
       a GTE problem (Pete's soft GPU plugin is very very compatible !)

   - The game pauses in MDEC videos.
   - The games' MDEC movies are displayed corrupted.
       Solution:  Sadly enough, ePSXe has an incomplete and buggy MDEC
       emulation. This means that some videos may pause in the middle.
       We recommend you to skip the videos using the command line commands
       and get another emulator or a real PSX when you really want to enjoy
       the videos.

   - The game only shows some titles from the movie in the left corner of
     the screen and stops afterwards.
       Solution:  This is the most problematic problem ePSXe has with MDECs
       and only occurs in few games. This bug is resulting from a timing
       problem and a bug in the CD-Rom emulation. It causes the MDEC to be
       not displayed sometimes and also causees very large breaks. We
       recommened you to skip the movie by pressing X or Start during
       startup for several seconds. Sorry, we'll try to fix this
       problem in a future version. In the meantime, you could try
       another emulator or, of course, get a real playstation :-)
 
   - The GAME still won't work.
       Solution:  If, after all, the game STILL won't work, than it's most
       propably simply not compatible with ePSXe right now. You should wait
       for the next version of the emulator. 

Sound.

   EPSXE comes with support for the PSEmu Pro sound plugins in this version.
   This includes ADPCM, CDDA and partial XA sound.  Common problems
   with the sound:

   - The game plays no sound at all
       Solution: Check the sound settings in the menu. When it's configured
       correctly, it's possible that this game is using some type of XA sound
       that hsan't been emulated correctly by ePSXE. Sorry, we'll try to add
       this in the future.

   - XA sound playback is jerky.
       Solution: XA sound in EPSXE is experimental right now, so don't
       expect a too accurate sound :-(((

******************************************************************************
6. Where can I get help with the emulator?
******************************************************************************

There are a number of ways to receive help. The first thing you should do is
read the documentation, since the majority of questions are already
answered in it. Also, you can use the following emulation newsgroups :

news://comp.emulator.misc
news://comp.emulator.game.consoles

Another way is to ask on an emulator related IRC channel, like #epsxe, #psxemu
or #emu in EFNET (get mIRC from http://www.mirc.com to connect)
Many people you'll meet there will know more than we do about fixing certain
problems that you may experience with this emulator, or they'll be able to
point you somewhere where you can find a solution for your problem.

This software is freeware, and we don't have a lot of time to answer
questions, but if any of the above methods fail, you can try to contact
us using the following ways, but don't always expect a reply from us !

calb, Galtor, _Demo_
-----------------------
email: calb@epsxe.com
email: galtor@epsxe.com
email: _Demo_@epsxe.com

******************************************************************************
A.  Frequently Asked Questions
******************************************************************************

* (Your favorite game here) doesn't work with EPSXE?  Why not ?

  We're sorry.  For now, try another emulator or a real playstation :).

* When will the next version of EPSXE be released?

  We don't know and won't tell you. Check the homepage for more infos.

* Where can I get the latest version of EPSXE?

  http://www.epsxe.com/
  In addition, a number of emulation related websites will carry it too.

*****************************************************************************
B. Thanks
*****************************************************************************

 Doomed        - A nice docs and love to emulation ;-)
 Pts           - Testing and moral support
 Vood          - Xplorer supporter
 Fennec        - A nice xplorer debugger
 Kazzuya       - For xa support and nice plugins
 Pete          - Some wonderfull plugins and emails
 Roor          - A bunch of good ideas
 Expert        - Some nice chats and info
 duddie/tratax - PSemu Pro crew
 JNS           - Gui help and multiple tests.
 GreenImp      - Testing.
 Bobbi         - Fixes to english docs
 fpse team     - Ideas and help with MDEC and sio
 1964 team     - Gui ideas

 Independent JPEG Group's for routines to decode jpeg.
 Segu, Nik, lewpy, null the and rest of the PSEmu Pro plugins programmers.

 More thanks to: zsknight, Zilmar, Jabo, Willy, Goi and Jose.

**************************************************************************
C. Legal Stuff
**************************************************************************

EPSXE Copyright 2000 EPSXE team.
Sony Playstation is registered trademark of Sony.
All mentioned games are registered trademarks of their authors or marks.
You may only be in possession of the copyrighted BIOS if you're legally
entitled to do so.Neither the ePSXe Team software nor its authors are
affiliated with Sony. ePSXe is freeware and can be distributed freely as
long as it is not modified or sold and the BIOS isn't packaged with the
program. This readme must be included with the executable.

When you use this software you do that at your own risk. The authors are
not responsible for any loss or damage resulting from the use or misuse
of this software. If you do not agree with these terms delete this
software immediately !

-------------------------------------------------------------------
calb   calb@epsxe.com
Galtor galtor@epsxe.com
_Demo_ _Demo_@epsxe.com
-------------------------------------------------------------------
http://www.epsxe.com
-------------------------------------------------------------------
